Azure Web PubSub Service REST API (stable:2024-12-01)

2025/02/26 • 25 new methods

HealthApi_GetServiceStatus (new)
Description :  Get service health status.
Reference :  Link ¶

⚼ Request

HEAD:  /api/health
{
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{}
WebPubSub_AddConnectionsToGroups (new)
Description :  Add filtered connections to multiple groups.
Reference :  Link ¶

⚼ Request

POST:  /api/hubs/{hub}/:addToGroups
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
groupsToAdd:
{
Description: Target groups and connection filter. ,
Required: True ,
}
{
groups:
{
Description: A list of groups which target connections will be added into ,
Required: False ,
}
[
string ,
]
,
filter:
{
Description: An OData filter which target connections satisfy ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The error object. ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
inner:
{
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
inner:
{
Required: False ,
}
string ,
}
,
}
,
}
WebPubSub_CloseAllConnections (new)
Description :  Close the connections in the hub.
Reference :  Link ¶

⚼ Request

POST:  /api/hubs/{hub}/:closeConnections
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
excluded:
{
Description: Exclude these connectionIds when closing the connections in the hub. ,
Required: False ,
}
array ,
reason:
{
Description: The reason closing the client connection. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The error object. ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
inner:
{
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
inner:
{
Required: False ,
}
string ,
}
,
}
,
}
WebPubSub_GenerateClientToken (new)
Description :  Generate token for the client to connect Azure Web PubSub service.
Reference :  Link ¶

⚼ Request

POST:  /api/hubs/{hub}/:generateToken
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
userId:
{
Description: User Id. ,
Required: False ,
}
string ,
role:
{
Description: Roles that the connection with the generated token will have. ,
Required: False ,
}
array ,
minutesToExpire:
{
Description: The expire time of the generated token. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
group:
{
Description: Groups that the connection will join when it connects. ,
Required: False ,
}
array ,
clientType:
{
Description: The type of client. Case-insensitive. If not set, it's "Default". For Web PubSub for Socket.IO, only the default value is supported. For Web PubSub, the valid values are 'Default' and 'MQTT'. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
token:
{
Description: The token value for the WebSocket client to connect to the service ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The error object. ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
inner:
{
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
inner:
{
Required: False ,
}
string ,
}
,
}
,
}
WebPubSub_RemoveConnectionsFromGroups (new)
Description :  Remove filtered connections from multiple groups.
Reference :  Link ¶

⚼ Request

POST:  /api/hubs/{hub}/:removeFromGroups
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
groupsToRemove:
{
Description: Target groups and connection filter. ,
Required: True ,
}
{
groups:
{
Description: A list of groups which target connections will be removed from ,
Required: False ,
}
[
string ,
]
,
filter:
{
Description: An OData filter which target connections satisfy ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The error object. ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
inner:
{
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
inner:
{
Required: False ,
}
string ,
}
,
}
,
}
WebPubSub_SendToAll (new)
Description :  Broadcast content inside request body to all the connected client connections.
Reference :  Link ¶

⚼ Request

POST:  /api/hubs/{hub}/:send
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
excluded:
{
Description: Excluded connection Ids. ,
Required: False ,
}
array ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
message:
{
Description: The payload body. ,
Required: True ,
}
string ,
filter:
{
Description: Following OData filter syntax to filter out the subscribers receiving the messages. ,
Required: False ,
}
string ,
messageTtlSeconds:
{
Description: The time-to-live (TTL) value in seconds for messages sent to the service. 0 is the default value, which means the message never expires. 300 is the maximum value. If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service. This parameter can help when the client's bandwidth is limited. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The error object. ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
inner:
{
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
inner:
{
Required: False ,
}
string ,
}
,
}
,
}
WebPubSub_CloseConnection (new)
Description :  Close the client connection.
Reference :  Link ¶

⚼ Request

DELETE:  /api/hubs/{hub}/connections/{connectionId}
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
connectionId:
{
Description: Target connection Id. ,
Required: True ,
}
string ,
reason:
{
Description: The reason closing the client connection. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The error object. ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
inner:
{
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
inner:
{
Required: False ,
}
string ,
}
,
}
,
}
WebPubSub_ConnectionExists (new)
Description :  Check if the connection with the given connectionId exists.
Reference :  Link ¶

⚼ Request

HEAD:  /api/hubs/{hub}/connections/{connectionId}
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
connectionId:
{
Description: The connection Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
x-ms-error-code: string ,
}
WebPubSub_SendToConnection (new)
Description :  Send content inside request body to the specific connection.
Reference :  Link ¶

⚼ Request

POST:  /api/hubs/{hub}/connections/{connectionId}/:send
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
connectionId:
{
Description: The connection Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
message:
{
Description: The payload body. ,
Required: True ,
}
string ,
messageTtlSeconds:
{
Description: The time-to-live (TTL) value in seconds for messages sent to the service. 0 is the default value, which means the message never expires. 300 is the maximum value. If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service. This parameter can help when the client's bandwidth is limited. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The error object. ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
inner:
{
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
inner:
{
Required: False ,
}
string ,
}
,
}
,
}
WebPubSub_RemoveConnectionFromAllGroups (new)
Description :  Remove a connection from all groups.
Reference :  Link ¶

⚼ Request

DELETE:  /api/hubs/{hub}/connections/{connectionId}/groups
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
connectionId:
{
Description: Target connection Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The error object. ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
inner:
{
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
inner:
{
Required: False ,
}
string ,
}
,
}
,
}
WebPubSub_GroupExists (new)
Description :  Check if there are any client connections inside the given group
Reference :  Link ¶

⚼ Request

HEAD:  /api/hubs/{hub}/groups/{group}
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
group:
{
Description: Target group name, which length should be greater than 0 and less than 1025. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
x-ms-error-code: string ,
}
WebPubSub_CloseGroupConnections (new)
Description :  Close connections in the specific group.
Reference :  Link ¶

⚼ Request

POST:  /api/hubs/{hub}/groups/{group}/:closeConnections
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
group:
{
Description: Target group name, which length should be greater than 0 and less than 1025. ,
Required: True ,
}
string ,
excluded:
{
Description: Exclude these connectionIds when closing the connections in the group. ,
Required: False ,
}
array ,
reason:
{
Description: The reason closing the client connection. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The error object. ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
inner:
{
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
inner:
{
Required: False ,
}
string ,
}
,
}
,
}
WebPubSub_SendToGroup (new)
Description :  Send content inside request body to a group of connections.
Reference :  Link ¶

⚼ Request

POST:  /api/hubs/{hub}/groups/{group}/:send
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
group:
{
Description: Target group name, which length should be greater than 0 and less than 1025. ,
Required: True ,
}
string ,
excluded:
{
Description: Excluded connection Ids ,
Required: False ,
}
array ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
message:
{
Description: The payload body. ,
Required: True ,
}
string ,
filter:
{
Description: Following OData filter syntax to filter out the subscribers receiving the messages. ,
Required: False ,
}
string ,
messageTtlSeconds:
{
Description: The time-to-live (TTL) value in seconds for messages sent to the service. 0 is the default value, which means the message never expires. 300 is the maximum value. If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service. This parameter can help when the client's bandwidth is limited. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The error object. ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
inner:
{
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
inner:
{
Required: False ,
}
string ,
}
,
}
,
}
WebPubSub_ListConnectionsInGroup (new)
Description :  List connections in a group.
Reference :  Link ¶

⚼ Request

GET:  /api/hubs/{hub}/groups/{group}/connections
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
group:
{
Description: Target group name, whose length should be greater than 0 and less than 1025. ,
Required: True ,
}
string ,
maxpagesize:
{
Description: The maximum number of connections to include in a single response. It should be between 1 and 200. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: The maximum number of connections to return. If the value is not set, then all the connections in a group are returned. ,
Format: int32 ,
Required: False ,
}
integer ,
continuationToken:
{
Description: A token that allows the client to retrieve the next page of results. This parameter is provided by the service in the response of a previous request when there are additional results to be fetched. Clients should include the continuationToken in the next request to receive the subsequent page of data. If this parameter is omitted, the server will return the first page of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
connectionId:
{
Description: A unique identifier of a connection. ,
Required: True ,
}
string ,
userId:
{
Description: The user ID of the connection. A user can have multiple connections. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: An absolute URL that the client can GET in order to retrieve the next page of the collection. ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The error object. ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
inner:
{
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
inner:
{
Required: False ,
}
string ,
}
,
}
,
}
WebPubSub_RemoveConnectionFromGroup (new)
Description :  Remove a connection from the target group.
Reference :  Link ¶

⚼ Request

DELETE:  /api/hubs/{hub}/groups/{group}/connections/{connectionId}
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
group:
{
Description: Target group name, which length should be greater than 0 and less than 1025. ,
Required: True ,
}
string ,
connectionId:
{
Description: Target connection Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The error object. ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
inner:
{
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
inner:
{
Required: False ,
}
string ,
}
,
}
,
}
WebPubSub_AddConnectionToGroup (new)
Description :  Add a connection to the target group.
Reference :  Link ¶

⚼ Request

PUT:  /api/hubs/{hub}/groups/{group}/connections/{connectionId}
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
group:
{
Description: Target group name, which length should be greater than 0 and less than 1025. ,
Required: True ,
}
string ,
connectionId:
{
Description: Target connection Id ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The error object. ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
inner:
{
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
inner:
{
Required: False ,
}
string ,
}
,
}
,
}
WebPubSub_RevokePermission (new)
Description :  Revoke permission for the connection.
Reference :  Link ¶

⚼ Request

DELETE:  /api/hubs/{hub}/permissions/{permission}/connections/{connectionId}
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
permission:
{
Description: The permission: current supported actions are joinLeaveGroup and sendToGroup. ,
Required: True ,
}
string ,
connectionId:
{
Description: Target connection Id. ,
Required: True ,
}
string ,
targetName:
{
Description: The meaning of the target depends on the specific permission. For joinLeaveGroup and sendToGroup, targetName is a required parameter standing for the group name. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The error object. ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
inner:
{
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
inner:
{
Required: False ,
}
string ,
}
,
}
,
}
WebPubSub_CheckPermission (new)
Description :  Check if a connection has permission to the specified action.
Reference :  Link ¶

⚼ Request

HEAD:  /api/hubs/{hub}/permissions/{permission}/connections/{connectionId}
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
permission:
{
Description: The permission: current supported actions are joinLeaveGroup and sendToGroup. ,
Required: True ,
}
string ,
connectionId:
{
Description: Target connection Id. ,
Required: True ,
}
string ,
targetName:
{
Description: The meaning of the target depends on the specific permission. For joinLeaveGroup and sendToGroup, targetName is a required parameter standing for the group name. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
x-ms-error-code: string ,
}
WebPubSub_GrantPermission (new)
Description :  Grant permission to the connection.
Reference :  Link ¶

⚼ Request

PUT:  /api/hubs/{hub}/permissions/{permission}/connections/{connectionId}
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
permission:
{
Description: The permission: current supported actions are joinLeaveGroup and sendToGroup. ,
Required: True ,
}
string ,
connectionId:
{
Description: Target connection Id. ,
Required: True ,
}
string ,
targetName:
{
Description: The meaning of the target depends on the specific permission. For joinLeaveGroup and sendToGroup, targetName is a required parameter standing for the group name. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The error object. ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
inner:
{
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
inner:
{
Required: False ,
}
string ,
}
,
}
,
}
WebPubSub_UserExists (new)
Description :  Check if there are any client connections connected for the given user.
Reference :  Link ¶

⚼ Request

HEAD:  /api/hubs/{hub}/users/{userId}
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
userId:
{
Description: Target user Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
x-ms-error-code: string ,
}
WebPubSub_CloseUserConnections (new)
Description :  Close connections for the specific user.
Reference :  Link ¶

⚼ Request

POST:  /api/hubs/{hub}/users/{userId}/:closeConnections
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
userId:
{
Description: The user Id. ,
Required: True ,
}
string ,
excluded:
{
Description: Exclude these connectionIds when closing the connections for the user. ,
Required: False ,
}
array ,
reason:
{
Description: The reason closing the client connection. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The error object. ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
inner:
{
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
inner:
{
Required: False ,
}
string ,
}
,
}
,
}
WebPubSub_SendToUser (new)
Description :  Send content inside request body to the specific user.
Reference :  Link ¶

⚼ Request

POST:  /api/hubs/{hub}/users/{userId}/:send
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
userId:
{
Description: The user Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
message:
{
Description: The payload body. ,
Required: True ,
}
string ,
filter:
{
Description: Following OData filter syntax to filter out the subscribers receiving the messages. ,
Required: False ,
}
string ,
messageTtlSeconds:
{
Description: The time-to-live (TTL) value in seconds for messages sent to the service. 0 is the default value, which means the message never expires. 300 is the maximum value. If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service. This parameter can help when the client's bandwidth is limited. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The error object. ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
inner:
{
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
inner:
{
Required: False ,
}
string ,
}
,
}
,
}
WebPubSub_RemoveUserFromAllGroups (new)
Description :  Remove a user from all groups.
Reference :  Link ¶

⚼ Request

DELETE:  /api/hubs/{hub}/users/{userId}/groups
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
userId:
{
Description: Target user Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The error object. ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
inner:
{
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
inner:
{
Required: False ,
}
string ,
}
,
}
,
}
WebPubSub_RemoveUserFromGroup (new)
Description :  Remove a user from the target group.
Reference :  Link ¶

⚼ Request

DELETE:  /api/hubs/{hub}/users/{userId}/groups/{group}
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
group:
{
Description: Target group name, which length should be greater than 0 and less than 1025. ,
Required: True ,
}
string ,
userId:
{
Description: Target user Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The error object. ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
inner:
{
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
inner:
{
Required: False ,
}
string ,
}
,
}
,
}
WebPubSub_AddUserToGroup (new)
Description :  Add a user to the target group.
Reference :  Link ¶

⚼ Request

PUT:  /api/hubs/{hub}/users/{userId}/groups/{group}
{
hub:
{
Description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. ,
Required: True ,
}
string ,
group:
{
Description: Target group name, which length should be greater than 0 and less than 1025. ,
Required: True ,
}
string ,
userId:
{
Description: Target user Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the REST APIs. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Description: The error object. ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
inner:
{
Required: False ,
}
{
code:
{
Description: A more specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
inner:
{
Required: False ,
}
string ,
}
,
}
,
}